home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / DIAL.HDR < prev    next >
Text File  |  1994-04-25  |  1KB  |  55 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _Dial(cPhoneNum, [nComPort]) --> nResult
  8.  
  9. PARAMETERS:
  10.  
  11. cPhoneNum : formatted phone number string to dial
  12. nComPort  : Optional: Com Port DEFAULT: 1
  13.  
  14. SHORT:
  15.  
  16. Dial a number on the specified com port.
  17.  
  18. DESCRIPTION:
  19.  
  20. _Dial() receives a formatted string containing a phone number to dial.
  21.  
  22. The specified com port is opened, the number is dialed and the function
  23. closes the com port and returns a numeric return value as soon as any key
  24. is pressed.
  25.  
  26. RETURN VALUES:
  27.  
  28. 0  - No Error
  29. -1 - Com Port Open Error
  30. -2 - Com Port Write Error
  31. n  - Scan Code of Key Pressed
  32.  
  33. To dial a number, present a message indicating that the user should press
  34. any key when the phone rings or to hang up.  Call _Dial().  When the
  35. phone rings, the user can press any key to issue a hang-up and the com
  36. port will be closed.  By this time, the user has picked up the handset, so
  37. the phone line will not be hung up.
  38.  
  39. Special Characters:
  40.  
  41. "," to pause for one second.
  42.  
  43. NOTE:
  44.  
  45.  
  46.  
  47. EXAMPLE:
  48.  
  49. ? 'Dialing Information: Press Enter to Talk or Hang up'
  50. t = _Dial('9,,555-1212')
  51.  
  52. Result: t = <inkey code of key pressed>
  53.  
  54. ******************************************************************************/
  55.